Adding Custom Entities Docs by dgreen15 · Pull Request #28734 · DataDog/documentation

dgreen15 · 2025-04-11T19:39:46Z

What does this PR do? What is the motivation?

Adding Custom Entities Docs

Merge instructions

Merge readiness:

Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

github-actions · 2025-04-11T19:53:58Z

Preview links (active after the `build_preview` check completes)

Modified Files

cswatt · 2025-04-11T20:01:37Z

Added DOCS-10606 to track documentation team review

domalessi

Just a few super minor tweaks!

Removed the (GA) prefixes on the bullets but kept the Preview ones -- we typically don't mark GA explicitly; it's assumed that in the absence of a Preview call-out, the feature is GA.

domalessi · 2025-04-17T17:08:37Z

 ## Key features

- **Expanded data model**: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.
+- **(GA) Expanded data model**: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.


Suggested change

- **(GA) Expanded data model**: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.

- **Expanded data model**: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.

domalessi · 2025-04-17T17:08:44Z

+- **(GA) Expanded data model**: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.

- **Multi-ownership**: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.
+- **(GA) Multi-ownership**: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.


Suggested change

- **(GA) Multi-ownership**: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.

- **Multi-ownership**: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.

domalessi · 2025-04-17T17:08:50Z

+- **(GA) Multi-ownership**: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.

- **Enhanced relationship mapping**: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.
+- **(GA) Enhanced relationship mapping**: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.


Suggested change

- **(GA) Enhanced relationship mapping**: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.

- **Enhanced relationship mapping**: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.

domalessi · 2025-04-17T17:09:01Z

+- **(GA) Enhanced relationship mapping**: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.

- **Inheritance of system metadata**: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2. 
+- **(GA)Inheritance of system metadata**: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2. 


Suggested change

- **(GA)Inheritance of system metadata**: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2.

- **Inheritance of system metadata**: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2.

domalessi · 2025-04-17T17:09:08Z

+- **(GA)Inheritance of system metadata**: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2. 

- **Precise code location**: You can add the mapping of your code location for your service. The `codeLocations` section in v3.0 specifies the locations of the code with the repository that contains the code and its associated `paths`. The `paths` attribute is a list of [globs][4] that should match paths in the repository.  
+- **(GA) Precise code location**: You can add the mapping of your code location for your service. The `codeLocations` section in v3.0 specifies the locations of the code with the repository that contains the code and its associated `paths`. The `paths` attribute is a list of [globs][4] that should match paths in the repository.


Suggested change

- **(GA) Precise code location**: You can add the mapping of your code location for your service. The `codeLocations` section in v3.0 specifies the locations of the code with the repository that contains the code and its associated `paths`. The `paths` attribute is a list of [globs][4] that should match paths in the repository.

- **Precise code location**: You can add the mapping of your code location for your service. The `codeLocations` section in v3.0 specifies the locations of the code with the repository that contains the code and its associated `paths`. The `paths` attribute is a list of [globs][4] that should match paths in the repository.

domalessi · 2025-04-17T17:09:22Z

+
+- **(PREVIEW) Custom Entities**: Define your own entity types beyond Service, System, Datastore, Queue, and API. Scope scorecards and actions to only apply to specific entity types.
+
+- **(PREVIEW) Integrations**: Direct integrations with third-party tools to dynamically source information related to your components (e.g. Github pull requests, PagerDuty incidents, Gitlab pipelines, etc.). Report on and write scorecard rules against any third-party source


Suggested change

- **(PREVIEW) Integrations**: Direct integrations with third-party tools to dynamically source information related to your components (e.g. Github pull requests, PagerDuty incidents, Gitlab pipelines, etc.). Report on and write scorecard rules against any third-party source

- **(In Preview) Integrations**: Integrate with third-party tools to dynamically source information related to your components (for example, GitHub pull requests, PagerDuty incidents, and GitLab pipelines). Report on and write scorecard rules against any third-party source.

domalessi · 2025-04-17T17:09:30Z

+
+- **(PREVIEW) Integrations**: Direct integrations with third-party tools to dynamically source information related to your components (e.g. Github pull requests, PagerDuty incidents, Gitlab pipelines, etc.). Report on and write scorecard rules against any third-party source
+
+- **(PREVIEW) Group by product or domain**: You can group systems or other components by products, offering multiple layers of hierachical grouping.


Suggested change

- **(PREVIEW) Group by product or domain**: You can group systems or other components by products, offering multiple layers of hierachical grouping.

- **(In Preview) Group by product or domain**: Organize components by product, enabling multiple layers of hierarchical grouping.

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

domalessi · 2025-04-17T18:21:05Z

/merge

dd-devflow · 2025-04-17T18:21:08Z

View all feedbacks in Devflow UI.

2025-04-17 18:21:08 UTC ℹ️ Start processing command /merge

2025-04-17 18:21:13 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 18m (p90).

2025-04-17 18:39:08 UTC ℹ️ MergeQueue: This merge request was merged

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

dgreen15 added 3 commits April 11, 2025 15:39

Update _index.md

306ca2f

Update v3-0.md

7cfab30

Update _index.md

5a167d8

dgreen15 marked this pull request as ready for review April 11, 2025 19:47

dgreen15 requested a review from a team as a code owner April 11, 2025 19:47

cswatt self-assigned this Apr 11, 2025

cswatt added the editorial review Waiting on a more in-depth review label Apr 11, 2025

cswatt removed their assignment Apr 11, 2025

domalessi reviewed Apr 17, 2025

View reviewed changes

dgreen15 and others added 4 commits April 17, 2025 13:25

Update content/en/software_catalog/service_definitions/_index.md

4666a40

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

Update content/en/software_catalog/service_definitions/v3-0.md

21bf4af

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

Update content/en/software_catalog/service_definitions/v3-0.md

afd2c20

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

Update v3-0.md

458faeb

domalessi approved these changes Apr 17, 2025

View reviewed changes

domalessi reviewed Apr 17, 2025

View reviewed changes

Comment thread content/en/software_catalog/service_definitions/v3-0.md Outdated

domalessi reviewed Apr 17, 2025

View reviewed changes

Comment thread content/en/software_catalog/service_definitions/v3-0.md Outdated

Apply suggestions from code review

a8216e9

domalessi reviewed Apr 17, 2025

View reviewed changes

Comment thread content/en/software_catalog/service_definitions/v3-0.md Outdated

domalessi added 2 commits April 17, 2025 13:31

Update content/en/software_catalog/service_definitions/v3-0.md

b94f741

Merge branch 'master' into dgreen15/adding-custom-entities

bbce168

dd-devflow Bot added mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: queued labels Apr 17, 2025

dd-mergequeue Bot merged commit 30cd32f into master Apr 17, 2025

dd-mergequeue Bot deleted the dgreen15/adding-custom-entities branch April 17, 2025 18:39

dd-devflow Bot removed the mergequeue-status: in_progress label Apr 17, 2025

dd-devflow Bot added the mergequeue-status: done label Apr 17, 2025

estherk15 pushed a commit that referenced this pull request May 8, 2025

Adding Custom Entities Docs (#28734)

ff785bc

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

	- (GA) Expanded data model: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.
	- Expanded data model: v3.0 supports multiple kinds of entities. You can organize your systems using various components such as systems, services, queues, and datastores.

	- (GA) Multi-ownership: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.
	- Multi-ownership: You can assign multiple owners to any objects defined through the v3.0 schema to specify multiple points of contact.

	- (GA) Enhanced relationship mapping: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.
	- Enhanced relationship mapping: With APM and USM data, you can automatically detect dependencies among components. v3.0 supports manual declaration to augment auto-detected system topology to ensure a complete overview of how components interact within your systems.

	- (GA)Inheritance of system metadata: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2.
	- Inheritance of system metadata: Components within a system automatically inherit the system's metadata. It's no longer necessary to declare metadata for all related components one-by-one as in v2.1 and v2.2.

	- (GA) Precise code location: You can add the mapping of your code location for your service. The `codeLocations` section in v3.0 specifies the locations of the code with the repository that contains the code and its associated `paths`. The `paths` attribute is a list of [globs][4] that should match paths in the repository.
	- Precise code location: You can add the mapping of your code location for your service. The `codeLocations` section in v3.0 specifies the locations of the code with the repository that contains the code and its associated `paths`. The `paths` attribute is a list of [globs][4] that should match paths in the repository.


		- (PREVIEW) Custom Entities: Define your own entity types beyond Service, System, Datastore, Queue, and API. Scope scorecards and actions to only apply to specific entity types.

		- (PREVIEW) Integrations: Direct integrations with third-party tools to dynamically source information related to your components (e.g. Github pull requests, PagerDuty incidents, Gitlab pipelines, etc.). Report on and write scorecard rules against any third-party source

	- (PREVIEW) Integrations: Direct integrations with third-party tools to dynamically source information related to your components (e.g. Github pull requests, PagerDuty incidents, Gitlab pipelines, etc.). Report on and write scorecard rules against any third-party source
	- (In Preview) Integrations: Integrate with third-party tools to dynamically source information related to your components (for example, GitHub pull requests, PagerDuty incidents, and GitLab pipelines). Report on and write scorecard rules against any third-party source.


		- (PREVIEW) Integrations: Direct integrations with third-party tools to dynamically source information related to your components (e.g. Github pull requests, PagerDuty incidents, Gitlab pipelines, etc.). Report on and write scorecard rules against any third-party source

		- (PREVIEW) Group by product or domain: You can group systems or other components by products, offering multiple layers of hierachical grouping.

	- (PREVIEW) Group by product or domain: You can group systems or other components by products, offering multiple layers of hierachical grouping.
	- (In Preview) Group by product or domain: Organize components by product, enabling multiple layers of hierarchical grouping.

Uh oh!

Conversation

dgreen15 commented Apr 11, 2025

What does this PR do? What is the motivation?

Merge instructions

Additional notes

Uh oh!

github-actions Bot commented Apr 11, 2025

Preview links (active after the build_preview check completes)

Modified Files

Uh oh!

cswatt commented Apr 11, 2025

Uh oh!

domalessi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domalessi commented Apr 17, 2025

Uh oh!

dd-devflow Bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Preview links (active after the `build_preview` check completes)

dd-devflow Bot commented Apr 17, 2025 •

edited

Loading